home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1995 March / macformat-022.iso / Shareware City / Science / RasMol2 / INSTALL < prev    next >
Encoding:
Text File  |  1994-10-28  |  12.4 KB  |  281 lines  |  [TEXT/ttxt]
  1.  
  2.                             RasMol 2.5
  3.               Molecular Graphics Visualisation tool.
  4.  
  5.                            Roger Sayle 
  6.                   BioMolecular Structures Group
  7.                    Glaxo Research & Development
  8.                      Greenford, Middlesex, UK.
  9.                            October 1994
  10.  
  11.  
  12.     This file explains how to transfer, compile and install RasMol v2.4 on
  13. your system. This version of the RasMol Molecular graphics package will 
  14. run on UNIX, VMS, Machintosh and Microsoft Windows (OS/2 and Windows NT). 
  15.  
  16. [1] Obtaining RasMol v2.5
  17. =========================
  18.  
  19. The current version of RasMol may be obtained by anonymous FTP from 
  20. either ftp.dcs.ed.ac.uk in the directory /pub/rasmol or from 
  21. src.doc.ic.ac.uk in the directory /packages/rasmol. These sites are
  22. also mirrored at several other locations around the world. RasMol may
  23. also be obtained by electronic mail by sending the message "help software"
  24. to "netserv@embl-heidelberg.de". Follow the instructions provided by
  25. EMBL for unpacking the software from the e-mail messages.
  26.  
  27. To transfer by anonymous ftp, type "ftp ftp.dcs.ed.ac.uk" on the command
  28. line. Several seconds later you'll be prompted for a username. Use the
  29. username "anonymous" and when asked for a password enter your e-mail
  30. address. Once logged in, type the command "cd pub/rasmol" to change
  31. the directory to /pub/rasmol and then type "binary" to avoid corrupting
  32. the files during the transfer. For each file you wish to transfer, type
  33. "get <filename>" and when you've finished type "quit". If these files 
  34. are subsequently transfered to other machines, please remember to
  35. transfer them in BINARY mode. The file sizes should be identical before
  36. and after the transfer.
  37.  
  38. Depending upon the type of machine, you'll need to transfer one or more 
  39. of the following files:
  40.  
  41.     RasMol2.tar.Z    UNIX 'tar'ed 'compress'ed archive containing the
  42.                         complete source code and documentation of the
  43.                         RasMol molecular graphics package.
  44.  
  45.     RasMol2.tar.gz  UNIX 'tar'ed 'gzip'ed archive containing the 
  46.                         complete source code and documentation of the
  47.                         RasMol molecular graphics package.
  48.  
  49.         rasmac.sit.hqx  Apple Machintosh 'BinHex' and 'StuffIt' archive
  50.                         of the RasMol source code including a 'fat'
  51.                         binary for both Machintosh and PowerMac.
  52.  
  53.         raswin.zip      MS-DOS PkZip archive of the MS Windows version
  54.                         of the RasMol source code including a binary
  55.                         for MS Windows v3.1.
  56.  
  57.         rasmenu.zip     MS-DOS PkZip archive of the Visual Basic Graphical
  58.                         User Interface to RasMol including executable.
  59.  
  60.  
  61. To unpack the file RasMol2.tar.Z on a UNIX machine type the command
  62. "uncompress RasMol2.tar.Z" and then the command "tar -xvf RasMol2.tar"
  63. to extract the files in a subdirectory under the current directory.
  64. Once the files have been sucessfully extract, you can delete the
  65. file RasMol2.tar with the command "rm RasMol2.tar".
  66.  
  67. To unpack the file RasMol2.tar.gz on a UNIX machine, type "gunzip
  68. RasMol2.tar.gz" to use GNU gunzip to uncompress the files. Then
  69. follow the instructions above.
  70.  
  71. To unpack the file rasmac.sit.hqx, start up the application "StuffIt 
  72. Expander" and select the option "Exapnd" from the "File" menu. This
  73. should create the folder "RasMol2". You can then delete the files
  74. "rasmac.sit.hqx" and "rasmac.sit" by dragging their file icon and
  75. dropping them on the "trash".
  76.  
  77. To unpack the files raswin.zip and rasmenu.zip, type the command
  78. "pkunzip -d raswin.zip" and "pkunzip -d rasmenu.zip". You must have
  79. version 2.04 or later of PKUNZIP.EXE
  80.  
  81.  
  82. [2] Compiling and Installing RasMol v2.5
  83. ========================================
  84.  
  85. UNIX X11:
  86. ---------
  87. [1] Modify the contents of the Makefile to determine your local C compiler,
  88.     compiler and linker options. The default set up is for an 8bit UNIX
  89.     workstation with the X11 shared memory extension, compiled using the
  90.     GNU C Compiler. Changing the line "CC=gcc" to "CC=cc" will use the
  91.     machines native compiler but will require changing "CFLAGS" for your
  92.     platform.
  93.  
  94.     RasMol may be built for E&S workstations using the command "make esv".
  95.  
  96.     Alternatively (or if the first method fails), type "xmkmf" to generate 
  97.     a Makefile for your particular system from the included Imakefile!
  98.  
  99.     A common problem is that SUN OpenWindows keeps its include files in the
  100.     directory /usr/openwin/include/X11, hence the compiler directive 
  101.     -I/usr/openwin/include must be added to CFLAGS.
  102.  
  103.  
  104.  
  105. [2] Modify the #defines in the file rasmol.h (see below)
  106.         Note: IBMPC should not be defined.
  107. [3] Compile the program using the UNIX make utility. (i.e. type "make")
  108. [4] Place the 'rasmol' executable on the execution PATH, i.e. /usr/local/bin
  109. [5] Install rasmol.hlp as /usr/local/lib/rasmol/rasmol.hlp (or at a loctaion
  110.     indicated by the environment variable RASMOLPATH).
  111. [6] If you have the UNIX utilities "uncompress" or "gunzip" ensure they are
  112.     on the user's default PATH.
  113. [7] Set the environment variable RASMOLPDBPATH to the directory containing
  114.     the Broohaven PDB database, if one exits.
  115. [8] Place any system wide initialisation parameters into the file "rasmolrc"
  116.     in the directory pointed to by RASMOLPATH.
  117. [9] It is possible to set-up RASMOLPATH and RASMOLPDBPATH each time the 
  118.     program is running by renaming rasmol to rasmol.exe, and using a script
  119.     similar to the one in "rasmol.sh" of the standard distribution.
  120. [10] If appropriate place "rasmol.1" or "rasmol.0" in the appropriate place
  121.      for UNIX man pages, and optionally place "rasmol.html" somewhere in 
  122.      your WWW hierarchy (if available at your site).
  123.  
  124.  
  125. MS Windows v3.1:
  126. ----------------
  127. [1] Use Makefile.pc instead of Makefile, by copying it to MAKEFILE.
  128. [2] Modify the contents of the Makefile to determine your local C compiler,
  129.     compiler and linker options. 
  130. [3] Modify the #defines in the file rasmol.h (see below)
  131.         Note: EIGHTBIT and IBMPC should all be defined
  132.               APPLEMAC, DIALBOX, MITSHM and TERMIOS should not be defined.
  133. [4] Compile the program using the Microsoft Optimizing C Compiler Version
  134.     7's (or Microsoft Visual C++'s) NMAKE program under MS-DOS.
  135. [5] Copy both the executable RASWIN.EXE, RASMOL.HLP and RASWIN.HLP to an
  136.     appropriate directory.
  137. [6] Install the program in MS Windows using the New option of the Program
  138.     Manager's File Menu. Set the Description of the Program to "RasWin v2.5"
  139.     and the Current Directory, to the directory containing the files.
  140. [7] Install the RasMol Help file using the New option of the Program
  141.     Manager's File Menu. Set the Description to "RasWin Manual", the
  142.     command to "C:\WINDOWS\WINHELP RASWIN.HLP" and the working directory
  143.     to the appropriate directory.
  144.  
  145. MS Windows NT:
  146. --------------
  147. [1] Use Makefile.nt instead of Makefile, by copying it to MAKEFILE.
  148. [2] Follow the instructions from [2] onwards as for MS Windows v3.1.
  149.  
  150.  
  151. Machintosh and PowerMac
  152. -----------------------
  153. [1] Create a project in either the Symmantec C/C++, Think C or Metrowerks 
  154.     C compiler environments and add all the C source files ("*.c") to 
  155.     the project. On 68k development systems all C files should be placed
  156.     in separate segments [however rasmac.c and applemac.c can share a
  157.     segment and abstree.c and command.c can share a segment].
  158. [2] Add the "rasmac.rsrc" resource file to the project.
  159. [3] For the Symantec/Think C environment add the "ANSI" library from 
  160.     "Standard Libraries" directory and the "MacTraps" library from the
  161.     "Mac Libraries Directory".
  162. [4] For the Metrowerks 68K Compiler add the libraries "MacOS.lib" and
  163.     "ANSI (2i) C.68K.Lib" to the project. [Note: If compiling for 4byte 
  164.     integer size and/or 68881 maths instructions select the approriate 
  165.     ANSI C Library].
  166. [5] For the Metrowerks PPC Compiler add the libraries "MWCRuntime.Lib",
  167.     "InterfaceLib", "MathLib" and "ANSI C.PPC.Lib".
  168. [6] In Metrowerk's "Edit" "Preferences" "Project" or Symmantec's "Project"
  169.     "Set Project Type", set the project type to Application (Type 'APPL'), 
  170.     Creator 'RSML', and the SIZE flags to include "is32bitCompatible", 
  171.     "isHighLevelEventAware", "localAndRemoteHLEvents".
  172. [7] Modify the #defines in the file "rasmol.h" (see below).
  173.         Note: APPLEMAC should all be defined
  174.               IBMPC, DIALBOX, MITSHM and TERMIOS should not be defined.
  175. [8] Compile RasMol using the "Build Application..." Menu Item.
  176. [9] To create a `fat' binary, use Apple's ResEdit to copy and paste the
  177.     CODE, DATA and XREF resources from the Metrowerks 68K executable 
  178.     into the resource fork of the Metrowerks PPC executable.
  179. [10] The Installed Application's name should be "RasMac v2.5"
  180.  
  181.  
  182. VAX/VMS
  183. -------
  184. [1] Modify the #defines in the file rasmol.h (see below)
  185.         Note: IBMPC, MITSHM and TERMIOS should not be defined.
  186. [2] Copy all the files from the "vms" directory to the source directory.
  187. [2] If your VAX site has an MMS license type the command "MMS",
  188.     otherwise use the DCL build script by typing "@build.com"
  189. [3] The program may be run by typing "RUN RASMOL.EXE", the X Windows
  190.     server is specified by a VMS command of the form:
  191.     SET DISPLAY/CREATE/TRANSPORT=TCPIP/NODE=<hostname>
  192. [4] The symbol should be defined the the path of RASMOL.EXE using :==
  193. [5] The file rasmol.vms contains a ascii VMS help file that can
  194.     be compiled in to the VMS on-line help system.
  195.  
  196.  
  197.  
  198.  
  199. COMPILATION DIRECTIVES
  200. ======================
  201.  
  202. The file rasmol.h contains a number of #define directives that control
  203. the runtime behaviour of the program. The following directives may be
  204. defined or undefined to suite the local site.
  205.  
  206. THIRTYTWOBIT
  207. EIGHTBIT    This determines whether RasMol will display and produce
  208.         8bit or 32(24) bit output. By default this symbol is defined
  209.         producing images with up to 256 colours. This symbol must 
  210.                 be defined if IBMPC is defined.
  211.  
  212. DIALBOX        This enables the use of a dials box, that is connected 
  213.         using the X Window System XInput extension. This option
  214.         requires that the program be compiled with the Xi and
  215.         Xext libraries. Note: libXi is called libXinput on some old
  216.         machines, so requires the compiler option -lXinput!
  217.  
  218. MITSHM         This option enables the use of the X Window System MIT shared
  219.         memory extension. This enables images to be displayed faster
  220.         when RasMol and the X11 server are running on the same host.
  221.         This option requires the program be compiled with the Xext
  222.         library. This is now enabled by default. This should be
  223.                 disabled on IBM RS/6000 and E&S ESV workstations as MITSHM
  224.                 support is not provided as standard.
  225.  
  226. TERMIOS        This directive enables the command line processing on UNIXs
  227.         that support the termios terminal handling routines. By 
  228.         leaving this symbol undefined, RasMol omits the interactive
  229.         command line interface. Undefining is not recommended!
  230.  
  231. APPLEMAC        This determines whether the program is to run on an Apple
  232.                 Machintosh or PowerMac. By default, this option is disabled.
  233.                 The Machintosh code may be compiled to be either EIGHTTBIT
  234.                 or THIRTYTWOBIT and will generate images effectively.
  235.  
  236. IBMPC           This determines whether the program is intended to run on an
  237.                 IBM PC or compatible under MS Windows. By default, this 
  238.                 option is disabled. If this option is defined the options 
  239.                 EIGHTBIT and INVERT must be defined, and TERMIOS undefined.
  240.  
  241. To summarise;
  242.     A typical UNIX build:
  243.         /* define IBMPC    */
  244.         /* define APPLEMAC */
  245.         /* define DIALBOX  */
  246.         #define TERMIOS
  247.         #define MITSHM
  248.         #define EIGHTBIT
  249.  
  250.     A typical Windows build:
  251.         #define IBMPC
  252.         /* define APPLEMAC */
  253.         /* define DIALBOX  */
  254.         /* define TERMIOS  */
  255.         /* define MITSHM   */
  256.         #define EIGHTBIT
  257.  
  258.     A typical Machintosh build:
  259.         /* define IBMPC    */
  260.         #define APPLEMAC
  261.         /* define APPLEMAC */
  262.         /* define DIALBOX  */
  263.         /* define TERMIOS  */
  264.         /* define MITSHM   */
  265.         #define EIGHTBIT
  266.         
  267.     A typical VMS build:
  268.         /* define IBMPC    */
  269.         /* define APPLEMAC */
  270.         /* define DIALBOX  */
  271.         /* define TERMIOS  */
  272.         /* define MITSHM   */
  273.         #define EIGHTBIT
  274.  
  275. Roger
  276. -- 
  277. Roger Sayle,                       INTERNET:  ras32425@ggr.co.uk
  278. Glaxo Research & Development (GRD)            ros@dcs.ed.ac.uk
  279. Greenford Road, Greenford          Tel:   (+44) 081 966 3567 (direct line)
  280. Middlesex UB6 0HE, UK.             Fax:   (+44) 081 966 4476
  281.